

package com.hazelcast.internal.metrics.impl;

import com.hazelcast.internal.metrics.ProbeFunction;

/**
 * Interface used for catching values of the dynamic metrics. The primary
 * use case for this interface is updating gauges with values of dynamic
 * metrics.
 */
interface MetricValueCatcher {
    /**
     * Catches metric value from a source object with a {@link ProbeFunction}.
     *
     * @param collectionId The identifier of the metric collection cycle
     *                     calling this method
     * @param source       The object to read the value from
     * @param function     The probe function that reads the value from the
     *                     {@code source} object
     */
    void catchMetricValue(long collectionId, Object source, ProbeFunction function);

    /**
     * Catches long value.
     *
     * @param collectionId The identifier of the metric collection cycle
     *                     calling this method
     * @param value        The value
     */
    void catchMetricValue(long collectionId, long value);

    /**
     * Catches double value.
     *
     * @param collectionId The identifier of the metric collection cycle
     *                     calling this method
     * @param value        The value
     */
    void catchMetricValue(long collectionId, double value);
}
